Skip to content

[ISSUE #11518] Add IntelliJ IDEA run configurations for local source debugging - #11517

Merged
ShannonDing merged 4 commits into
apache:developfrom
whuerboy:feat/idea-source-debug
Nov 17, 2026
Merged

ShannonDing merged 4 commits into
apache:developfrom
whuerboy:feat/idea-source-debug

Conversation

@whuerboy

@whuerboy whuerboy commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Which Issue(s) This PR Fixes

Related issue: #11518 .

Brief Description

Starting NameServer and Broker from source in IntelliJ IDEA requires manually configuring launch parameters, local storage paths, and protocol source generation.

This PR provides shared run configurations and documentation to simplify local startup and debugging:

  • Add Source - NameServer and Source - Broker run configurations with project-relative paths and Maven compilation before launch.
  • Add local server configuration files with reduced resource limits and runtime data stored under devenv/idea/.
  • Register the generated Protobuf and gRPC Java source directories in rocketmq-proto/pom.xml for IDE Maven import.
  • Document JDK 17 setup, protocol submodule initialization, startup order, client configuration, and troubleshooting.
  • Link the debugging guide from CONTRIBUTING.md.

How Did You Test This Change?

Validation pending:

  • Compile NameServer, Broker, and their dependencies with JDK 17.
  • Reload the Maven project in IntelliJ IDEA and verify that generated protocol sources are recognized.
  • Launch NameServer and Broker using the shared run configurations.
  • Confirm that Broker registers successfully with NameServer.
  • Send and consume a test message through 127.0.0.1:9876.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.79%. Comparing base (0e48015) to head (9d7c13a).
⚠️ Report is 15 commits behind head on develop.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop   #11517      +/-   ##
=============================================
+ Coverage      49.74%   49.79%   +0.05%     
- Complexity     14368    14406      +38     
=============================================
  Files           1390     1391       +1     
  Lines         103262   103381     +119     
  Branches       13503    13529      +26     
=============================================
+ Hits           51365    51481     +116     
+ Misses         45703    45689      -14     
- Partials        6194     6211      +17     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ShannonDing ShannonDing changed the title [Improvement] Add IntelliJ IDEA run configurations for local source debugging [ISSUE #11518] Add IntelliJ IDEA run configurations for local source debugging Nov 16, 2026
@ShannonDing
ShannonDing merged commit 3e34840 into apache:develop Nov 17, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Enhancement] Improve local source debugging with shared IntelliJ IDEA run configurations

3 participants